/*
 * Wind.h
 * This file is part of WX
 *
 * Copyright 2010-2013 Jason Coulls. All Rights Reserved.
 *
 * is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, version 2 of the License.
 *
 * is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with . If not, see <http://www.gnu.org/licenses>.
 */

#import <Foundation/Foundation.h>

/**
 This class represents a wind.
 */
@interface Wind : NSObject

/**
 An enumeration of wind speed scales
 */
typedef enum {
    kSPEEDMPH,       /**< this speed is represented in MPH */
    kSPEEDKMH,       /**< this speed is represented in KMH */
    KSPEEDKNOTS      /**< this speed is represented in Knots */
} SpeedScale;

/**
 The speed reading.
 */
@property   double      reading;

/**
 The speed reading scale being represented.
 */
@property   SpeedScale  speedScale;

/**
 The direction in degrees the wind is coming from.
 */
@property   int         directionDegrees;

/**
 Converts the current speed measurement to its MPH value.
 @returns returns the wind speed in MPH.
 */
-(double) speedInMPH;

/**
 Converts the current speed measurement to its KPH value.
 @returns returns the wind speed in KMH.
 */
-(double) speedInKMH;

/**
 Converts the current speed measurement to its Knots value.
 @returns returns the wind speed in knots.
 */
-(double) speedInKnots;


@end
